English for post Writing Guidelines

When contributing to this repository, please follow the following guidelines for writing posts:

1. Tags and Categories

• tag: Each post should include relevant tags that describe the content and make it easier for readers to find. Tags should be separated by commas and should be chosen from the pre-defined list of tags (if applicable).

2. Formatting

• Title: The title of the post should be clear and concise, and should accurately reflect the content of the post.

• Header Structure: Use headers (#, ##, ###, etc.) to organize the content of the post and make it easier for readers to navigate.

• Images and Media: If applicable, include relevant images and media to enhance the post. Please ensure that all media is properly credited and licensed for use.

• Links: Use links to provide additional information or sources for the content in the post.

3. Content

• Originality: The content of the post should be original and not copied from other sources.

• Quality: The content should be well-written, informative, and engaging. Avoid using jargon or technical language that may be difficult for readers to understand.

• Length: While there is no strict length requirement, posts should be long enough to provide a comprehensive and meaningful discussion of the topic.

4. Submission

• File Format: Posts should be submitted in Markdown format (.md).

• Naming Convention: Posts should be named using the following convention: notes/posts/XXX.md.

• Pull Requests: Submit your post as a pull request to the appropriate branch of the repository. Please include a brief description of the post and any relevant tags or categories in the pull request.

By following these guidelines, you can help ensure that the posts in this repository are high-quality, informative, and easy to find. Thank you for your contribution!